RC-Astro CLI Wrapper

By FlapAstro


Version 0.10.2. A PixInsight V8 graphical wrapper for the stand-alone RC-Astro command-line tools. [more]

Keywords: RC-Astro, BlurXTerminator, StarXTerminator, NoiseXTerminator, PixInsight, deconvolution, star removal, noise reduction

Contents

[hide]

1 Description

[hide]

RC-Astro CLI Wrapper provides a PixInsight graphical interface for the stand-alone BlurXTerminator, StarXTerminator, and NoiseXTerminator command-line tools. It can process the active PixInsight view or image files selected manually. The documentation button beside the Preferences button opens this bundled compiler-generated PIDoc page.

1.1 Requirements

PixInsight 1.9.5 or newer with the V8 JavaScript runtime is required. RC-Astro CLI version 1.0.0 or newer is required. This release has been tested with RC-Astro CLI version 1.1.3.

1.2 Startup checks

At startup, the script locates the configured RC-Astro executable and reads its machine-readable catalog with rc-astro --json. Versions older than 1.0.0 are rejected. Versions newer than 1.1.3 generate a warning because they were not available when this wrapper was tested. When the check succeeds, the main status area displays Ready together with the installed CLI version and executable path.

1.3 Processing modes

  • Active PixInsight view saves a temporary XISF copy of the selected view, runs RC-Astro, and opens the result as a new image.
  • Manual file processes an input file and writes to the selected output path.

The triangular New Instance button at the lower left creates a standard PixInsight process icon containing the current RC-Astro processing settings. Drag or click the icon onto a view to reuse those settings. Active-view instances obtain their image from the target or active view; manual-file instances also retain their input, output, and log paths. Machine-specific executable and temporary-directory preferences, detected CLI status, progress, and other transient run-time state are deliberately excluded. Configure machine-specific paths with the Preferences button on each computer.

When a result is opened, the wrapper copies the exact screen transfer function (STF) of the input view. A nonidentity STF is retained for the usual linear-image workflow, while an identity STF remains identity for an already stretched nonlinear image, avoiding an unintended second stretch. This changes display only and never modifies output pixels. In manual-file mode the STF can be copied only when the selected input file is already open in PixInsight; otherwise the result opens with its default identity STF. The same rule is applied to an optional StarXTerminator stars-only output.

1.4 BlurXTerminator

Automatic nonstellar PSF is the normal mode. BlurXTerminator estimates the PSF from stars and can correct optical aberrations in nonstellar features.

For starless, lunar, or planetary images, disable automatic nonstellar PSF and set the nonstellar diameter to the expected stellar FWHM in pixels. Manual mode assumes a round PSF and cannot correct optical aberrations.

This wrapper uses the RC-Astro 1.0.0 and later parameters --auto-nonstellar-psf and --nonstellar-diameter. The obsolete radius parameters are not used.

1.5 StarXTerminator

The StarXTerminator panel provides optional stars-image output and unscreened-stars controls in addition to the common RC-Astro options.

1.6 NoiseXTerminator

The NoiseXTerminator panel provides controls for luminance and color denoising, frequency scale, and iterations. The newer ML3 model produces the same result with improved execution speed on Windows and Linux. The macOS NoiseXTerminator ML3 model was not updated with this optimization.

1.7 Progress and cancellation

RC-Astro output is monitored while processing. A job is stopped if the process produces no new output for 5 minutes. The total processing time is otherwise not limited. Closing the dialog during processing requests cancellation. Completion and failure details are shown in the main status area and written to the PixInsight console; successful completion does not display a modal popup.

1.8 Troubleshooting

  • CLI not found: Open Preferences and select the installed rc-astro executable.
  • Version check failed: Run rc-astro --json in a terminal and verify that it returns a cliVersion.
  • Exit code 77: The selected RC-Astro product is not licensed on this computer.
  • Missing output: Inspect the full log and verify that the output directory is writable.

1.9 CPD status and release requirements

The current wrapper exports images and launches the standalone RC-Astro CLI to process them. This architecture conflicts with CPD rule 5.8 unless PTeam grants a written exception under rule 5.6. No such exception has been verified for this documentation update. A valid CPD signature identifies the signer and protects integrity; it does not establish product approval or compliance. Documentation changes do not resolve this architectural limitation.

CPD rules version 1.0.2 were published on October 29, 2026, with an effective date of December 12, 2026. Rule 10.2 gives existing CPDs 60 days from notification to comply; the applicable notification date must be checked separately.

Rules: https://pixinsight.com/security/cpd-rules/

1.10 Execution and user choice

The script launches the configured RC-Astro executable with –json at startup, before its main dialog opens, to check compatibility. If no path has been saved, it searches C:/Program Files/RC-Astro/cli/rc-astro.exe, C:/Program Files/RC-Astro/rc-astro.exe, and C:/Program Files (x86)/RC-Astro/cli/rc-astro.exe. Preferences lets the user select another executable; saving a valid selection also probes it. Successful probes are cached for the script session. Processing launches the same executable with the selected bxt, sxt, or nxt command and arguments. The wrapper does not install or license the CLI.

1.11 Files and storage

The default working directory is the operating-system temporary directory returned by File.systemTempDirectory. The user can change it in Preferences. Active-view mode writes VIEW_ID_rcastro_input.xisf, VIEW_ID_BXT.xisf, VIEW_ID_SXT.xisf, or VIEW_ID_NXT.xisf, and VIEW_ID_rcastro_TOOL.log in that directory. The view identifier is sanitized for filenames. Manual-file mode uses the selected input, output, and log paths. StarXTerminator can additionally produce a companion stars image beside its main output.

1.12 Retention and overwrite

The temporary active-view input is deleted after completion, failure, or cancellation unless Keep temporary input file is enabled. Outputs and logs are retained; there is no automatic cleanup for them. Temporary filenames are deterministic rather than unique per run. An existing temporary input at the generated path is removed before export. Overwrite is enabled by default; when enabled, existing main outputs and recognized stars-output candidates are removed before processing, so a failed run does not restore them. Use a dedicated working directory and preserve needed outputs before another run.

1.13 Logs and preferences

Logs contain timestamps, executable and image paths, selected command and arguments, processing status, and RC-Astro stdout/stderr. Extra command-line arguments can consequently appear in logs; do not include secrets in them. Preferences are stored through the PJSR Settings interface under RcAstroGUI/. The wrapper does not directly edit PixInsight core settings files. Review logs before sharing them.

1.14 Result opening

The Open result option controls opening the main output. When StarXTerminator stars output is requested and a recognized companion file is found, the current code opens that stars image even if Open result is disabled. The wrapper copies the input display STF when available without changing output pixels.

1.15 Network and third-party behaviour

RcAstro.js contains no direct network-transfer or telemetry calls and no executable downloader. This is a source-level statement about the wrapper, not a guarantee about the separately installed RC-Astro CLI. The CLI's network connections, licensing traffic, model downloads, cache locations, and integrity verification have not been verified here. Do not describe the combined product as offline or fully compliant on this basis. Before any release represented as CPD-compliant, verify and document those behaviours for supported CLI versions, including endpoints, purposes, storage locations, secure transport, integrity checks, and any consent requirements.

1.16 License and warranty

The FlapAstro wrapper is licensed under the PolyForm Noncommercial License 1.0.0.

This software is provided "AS IS", without warranty of any kind, including fitness for a particular purpose. Use is entirely at the user's sole risk and responsibility.

2 Acknowledgments

[hide]

This software was developed with assistance from OpenAI Codex. The resulting code was reviewed, tested, and is maintained under the responsibility of FlapAstro.

RC-Astro CLI, BlurXTerminator, StarXTerminator, and NoiseXTerminator are proprietary software of RC Astro, LLC. PixInsight and the PixInsight JavaScript Runtime are software of Pleiades Astrophoto S.L. These products remain subject to their respective separate licenses and are not included with this wrapper. All product names and trademarks belong to their respective owners. This independent wrapper is not endorsed by either company.